<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>module Net::IMAP::SASL::StringPrep - net-imap: Ruby Standard Library Documentation</title>


<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>

<script src="../../../js/jquery-3.2.0.min.js"></script>

<script src="../../../js/vue.min.js"></script>
<script src="../../../js/js.cookie.min.js"></script>

<link href="../../../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../../../css/rdoc.css" rel="stylesheet">
<link href="../../../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../../";
  var index_rel_prefix = "../../../";
  var darkModeCsseHref = "../../../css/rdoc-dm.css"
  var defaultModeCssHref = "../../../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="module">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../../../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../../../table_of_contents.html#pages">Pages</a>
    <a href="../../../table_of_contents.html#classes">Classes</a>
    <a href="../../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-5B-5D">::[]</a>
    <li ><a href="#method-i-check_bidi-21">#check_bidi!</a>
    <li ><a href="#method-i-check_prohibited-21">#check_prohibited!</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="module-Net::IMAP::SASL::StringPrep">
    <h1 id="module-Net::IMAP::SASL::StringPrep" class="module">
      module Net::IMAP::SASL::StringPrep
    </h1>

    <section class="description">
    
<p>Regexps and utility methods for implementing stringprep profiles.  The StringPrep algorithm is defined by <a href="https://www.rfc-editor.org/rfc/rfc3454.html">RFC-3454</a>.  Each codepoint table defined in the RFC-3454 appendices is matched by a Regexp defined in this module.</p>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">


      <section class="constants-list">
      <header>
      <h3>Constants</h3>
      </header>
      <dl>
          <dt id="BIDI_DESC_REQ2">BIDI_DESC_REQ2
          <dd>
          <dt id="BIDI_DESC_REQ3">BIDI_DESC_REQ3
          <dd>
          <dt id="BIDI_FAILS_REQ2">BIDI_FAILS_REQ2
          <dd><dl class="rdoc-list note-list"><dt>Bidirectional Characters [StringPrep, §6], Requirement 2
<dd>
<p>If a string contains any RandALCat character, the string MUST NOT contain any LCat character.</p>
</dd></dl>
          <dt id="BIDI_FAILS_REQ3">BIDI_FAILS_REQ3
          <dd><dl class="rdoc-list note-list"><dt>Bidirectional Characters [StringPrep, §6], Requirement 3
<dd>
<p>If a string contains any RandALCat character, a RandALCat character MUST be the first character of the string, and a RandALCat character MUST be the last character of the string.</p>
</dd></dl>
          <dt id="BIDI_FAILURE">BIDI_FAILURE
          <dd><p>Bidirectional Characters [StringPrep, §6]</p>
          <dt id="IN_A_1">IN_A_1
          <dd><p>Unassigned code points in Unicode 3.2 StringPrep["A.1"]</p>
          <dt id="IN_B_1">IN_B_1
          <dd><p>Commonly mapped to nothing StringPrep["B.1"]</p>
          <dt id="IN_B_2">IN_B_2
          <dd><p>Mapping for case-folding used with NFKC StringPrep["B.2"]</p>
          <dt id="IN_B_3">IN_B_3
          <dd><p>Mapping for case-folding used with no normalization StringPrep["B.3"]</p>
          <dt id="IN_C_1_1">IN_C_1_1
          <dd><p>ASCII space characters StringPrep["C.1.1"]</p>
          <dt id="IN_C_1_2">IN_C_1_2
          <dd><p>Non-ASCII space characters StringPrep["C.1.2"]</p>
          <dt id="IN_C_2_1">IN_C_2_1
          <dd><p>ASCII control characters StringPrep["C.2.1"]</p>
          <dt id="IN_C_2_2">IN_C_2_2
          <dd><p>Non-ASCII control characters StringPrep["C.2.2"]</p>
          <dt id="IN_C_3">IN_C_3
          <dd><p>Private use StringPrep["C.3"]</p>
          <dt id="IN_C_4">IN_C_4
          <dd><p>Non-character code points StringPrep["C.4"]</p>
          <dt id="IN_C_5">IN_C_5
          <dd><p>Surrogate codes StringPrep["C.5"]</p>
          <dt id="IN_C_6">IN_C_6
          <dd><p>Inappropriate for plain text StringPrep["C.6"]</p>
          <dt id="IN_C_7">IN_C_7
          <dd><p>Inappropriate for canonical representation StringPrep["C.7"]</p>
          <dt id="IN_C_8">IN_C_8
          <dd><p>Change display properties or are deprecated StringPrep["C.8"]</p>
          <dt id="IN_C_9">IN_C_9
          <dd><p>Tagging characters StringPrep["C.9"]</p>
          <dt id="IN_D_1">IN_D_1
          <dd><p>Characters with bidirectional property “R” or “AL” StringPrep["D.1"]</p>
          <dt id="IN_D_1_NEGATED">IN_D_1_NEGATED
          <dd><p>Used to check req3 of bidirectional checks Matches the negation of the D.1 table</p>
          <dt id="IN_D_2">IN_D_2
          <dd><p>Characters with bidirectional property “L” StringPrep["D.2"]</p>
          <dt id="TABLE_REGEXPS">TABLE_REGEXPS
          <dd><p>Regexps matching each codepoint table in the RFC-3454 appendices</p>
          <dt id="TABLE_TITLES">TABLE_TITLES
          <dd><p>Names of each codepoint table in the RFC-3454 appendices</p>
        </dl>
        </section>



                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-5B-5D" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">[]</span><span
                                class="method-args">(table)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns a Regexp matching the given <code>table</code> name.</p>

                              <div class="method-source-code" id="5B-5D-source">
            <pre><span class="ruby-comment"># File net-imap-0.3.7/lib/net/imap/sasl/stringprep.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">table</span>)
  <span class="ruby-constant">TABLE_REGEXPS</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">table</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-check_bidi-21" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">check_bidi!</span><span
                                class="method-args">(string, c_8: false, profile: nil)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Checks that <code>string</code> obeys all of the “Bidirectional Characters” requirements in RFC-3454, §6:</p>
<ul><li>
<p>The characters in StringPrep["C.8"] MUST be prohibited</p>
</li><li>
<p>If a string contains any RandALCat character, the string MUST NOT contain any LCat character.</p>
</li><li>
<p>If a string contains any RandALCat character, a RandALCat character MUST be the first character of the string, and a RandALCat character MUST be the last character of the string.</p>
</li></ul>

<p>This is usually combined with <a href="StringPrep.html#method-i-check_prohibited-21"><code>check_prohibited!</code></a>, so table “C.8” is only checked when <code>c_8: true</code>.</p>

<p>Raises either <a href="ProhibitedCodepoint.html"><code>ProhibitedCodepoint</code></a> or <a href="BidiStringError.html"><code>BidiStringError</code></a> unless all requirements are met.  <code>profile</code> is an optional string which will be added to any exception that is raised (it does not affect behavior).</p>

                              <div class="method-source-code" id="check_bidi-21-source">
            <pre><span class="ruby-comment"># File net-imap-0.3.7/lib/net/imap/sasl/stringprep.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_bidi!</span>(<span class="ruby-identifier">string</span>, <span class="ruby-value">c_8:</span> <span class="ruby-keyword">false</span>, <span class="ruby-value">profile:</span> <span class="ruby-keyword">nil</span>)
  <span class="ruby-identifier">check_prohibited!</span>(<span class="ruby-identifier">string</span>, <span class="ruby-string">&quot;C.8&quot;</span>, <span class="ruby-value">profile:</span> <span class="ruby-identifier">profile</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">c_8</span>
  <span class="ruby-keyword">if</span> <span class="ruby-constant">BIDI_FAILS_REQ2</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">string</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-constant">BidiStringError</span>.<span class="ruby-identifier">new</span>(
      <span class="ruby-constant">BIDI_DESC_REQ2</span>, <span class="ruby-value">string:</span> <span class="ruby-identifier">string</span>, <span class="ruby-value">profile:</span> <span class="ruby-identifier">profile</span>,
    )
  <span class="ruby-keyword">elsif</span> <span class="ruby-constant">BIDI_FAILS_REQ3</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">string</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-constant">BidiStringError</span>.<span class="ruby-identifier">new</span>(
      <span class="ruby-constant">BIDI_DESC_REQ3</span>, <span class="ruby-value">string:</span> <span class="ruby-identifier">string</span>, <span class="ruby-value">profile:</span> <span class="ruby-identifier">profile</span>,
    )
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-check_prohibited-21" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">check_prohibited!</span><span
                                class="method-args">(string, *tables, bidi: false, profile: nil)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Checks <code>string</code> for any codepoint in <code>tables</code>. Raises a <a href="ProhibitedCodepoint.html"><code>ProhibitedCodepoint</code></a> describing the first matching table.</p>

<p>Also checks bidirectional characters, when <code>bidi: true</code>, which may raise a <a href="BidiStringError.html"><code>BidiStringError</code></a>.</p>

<p><code>profile</code> is an optional string which will be added to any exception that is raised (it does not affect behavior).</p>

                              <div class="method-source-code" id="check_prohibited-21-source">
            <pre><span class="ruby-comment"># File net-imap-0.3.7/lib/net/imap/sasl/stringprep.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_prohibited!</span>(<span class="ruby-identifier">string</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">tables</span>, <span class="ruby-value">bidi:</span> <span class="ruby-keyword">false</span>, <span class="ruby-value">profile:</span> <span class="ruby-keyword">nil</span>)
  <span class="ruby-identifier">tables</span> = <span class="ruby-constant">TABLE_TITLES</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp">/^C/</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">tables</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-identifier">tables</span> <span class="ruby-operator">|=</span> <span class="ruby-node">%w[C.8]</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">bidi</span>
  <span class="ruby-identifier">table</span> = <span class="ruby-identifier">tables</span>.<span class="ruby-identifier">find</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-constant">TABLE_REGEXPS</span>[<span class="ruby-identifier">t</span>].<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">string</span>) }
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ProhibitedCodepoint</span>.<span class="ruby-identifier">new</span>(
    <span class="ruby-identifier">table</span>, <span class="ruby-value">string:</span> <span class="ruby-identifier">string</span>, <span class="ruby-value">profile:</span> <span class="ruby-keyword">nil</span>
  ) <span class="ruby-keyword">if</span> <span class="ruby-identifier">table</span>
  <span class="ruby-identifier">check_bidi!</span>(<span class="ruby-identifier">string</span>, <span class="ruby-value">profile:</span> <span class="ruby-identifier">profile</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">bidi</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>.</p><p><a href="https://jamesbritt.bandcamp.com/">Maximum R+D</a>.  </p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

